Scripting > CxEditors > CxVhsEditor Object > CxVhsEditor Methods

CxVhsEditor Methods

The CxVhsEditor object contains the following methods:

Connect

The Connect method connects to a VHS.

Syntax

Connect(DomainSiteService As String)

Parameters

Parameter Required Description

DomainSiteService

Yes

The [Domain]Site.Service to which to connect.  A domain is optional. The service must be a valid VHS.

Example

The following example creates and connects the CxVhsEditor object.

Sub

Dim VhsEditor

Set VhsEditor = CreateObject("CxEditors.CxVhsEditor")

VhsEditor.Connect("[5410]CYGDEMO.VHS")

End Sub

Back to top

Copy

This method is unimplemented.

Back to top

Delete

This method is unimplemented.

Back to top

Disconnect

The Disconnect method disconnects from the connected VHS service.

Syntax

Disconnect()

Example

The following example disconnects the VhsEditor object.

Sub

VhsEditor.Disconnect

End Sub

Back to top

DisplayValues

The DisplayValues method displays a History Values dialog box for the specified point.

Syntax

DisplayValues(PointTag As String) As Integer

Parameters

Parameter Required Description

PointTag

Yes

The tag of the point for which to display values.  The point tag can be in one of the following forms:

  • SITE.SERVICE.POINTID
  • SITE.SERVICE:POINTIDLONG
  • SITE.SERVICE.POINTID:POINTIDLONG

Remarks

This method returns one of the following values:

  -1 or 0 An error occurred.
 

1

dialog box closed successfully.

Example

The following example displays a History Values dialog box for point "CYGDEMO.UIS.00001388."

Sub

Dim iRet

iRet= VhsEditor.DisplayValues("CYGDEMO.UIS.00001388")

MsgBox iRet

End Sub

Back to top

Edit

This method is unimplemented.

Back to top

New

This method is unimplemented.

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.